<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Docpad</title>
    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="icon" href="../assets/favicon.ico">
    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
                <h1><img src="../assets/css/logo.png" title="" width="117" height="52"></h1>
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: </em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
                    <h2 class="off-left">APIs</h2>
                    <div id="api-tabview" class="tabview">
                        <ul class="tabs">
                            <li><a href="#api-classes">Classes</a></li>
                            <li><a href="#api-modules">Modules</a></li>
                        </ul>
                
                        <div id="api-tabview-filter">
                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
                        </div>
                
                        <div id="api-tabview-panel">
                            <ul id="api-classes" class="apis classes">
                                <li><a href="../classes/BasePlugin.html">BasePlugin</a></li>
                                <li><a href="../classes/Collection.html">Collection</a></li>
                                <li><a href="../classes/Docpad.html">Docpad</a></li>
                                <li><a href="../classes/docpadUtil.html">docpadUtil</a></li>
                                <li><a href="../classes/DocumentModel.html">DocumentModel</a></li>
                                <li><a href="../classes/ElementsCollection.html">ElementsCollection</a></li>
                                <li><a href="../classes/Events.html">Events</a></li>
                                <li><a href="../classes/FileModel.html">FileModel</a></li>
                                <li><a href="../classes/FilesCollection.html">FilesCollection</a></li>
                                <li><a href="../classes/MetaCollection.html">MetaCollection</a></li>
                                <li><a href="../classes/Model.html">Model</a></li>
                                <li><a href="../classes/PluginLoader.html">PluginLoader</a></li>
                                <li><a href="../classes/PluginTester.html">PluginTester</a></li>
                                <li><a href="../classes/QueryCollection.html">QueryCollection</a></li>
                                <li><a href="../classes/ScriptCollection.html">ScriptCollection</a></li>
                                <li><a href="../classes/ServerTester.html">ServerTester</a></li>
                                <li><a href="../classes/StylesCollection.html">StylesCollection</a></li>
                            </ul>
                
                
                            <ul id="api-modules" class="apis modules">
                            </ul>
                        </div>
                    </div>
                </div>
            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
                    Show:
                    <label for="api-show-inherited">
                        <input type="checkbox" id="api-show-inherited" checked>
                        Inherited
                    </label>
            
                    <label for="api-show-protected">
                        <input type="checkbox" id="api-show-protected">
                        Protected
                    </label>
            
                    <label for="api-show-private">
                        <input type="checkbox" id="api-show-private">
                        Private
                    </label>
                    <label for="api-show-deprecated">
                        <input type="checkbox" id="api-show-deprecated">
                        Deprecated
                    </label>
            
                </div>
            
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
<h1>Docpad Class</h1>
<div class="box meta">

        <div class="extends">
            Extends EventEmitterGrouped
        </div>

        <div class="foundat">
            Defined in: <a href="../files/src_lib_docpad.coffee.html#l118"><code>src&#x2F;lib&#x2F;docpad.coffee:118</code></a>
        </div>


</div>


<div class="box intro">
    <p>Contains methods for managing the DocPad application.
This includes managing a DocPad projects files and
documents, watching directories, emitting events and
managing the node.js/express.js web server.
Extends <a href="https://github.com/bevry/event-emitter-grouped">https://github.com/bevry/event-emitter-grouped</a></p>
<p>The class is instantiated in the docpad-server.js file
which is the entry point for a DocPad application.</p>
<pre class="code prettyprint"><code>new DocPad(docpadConfig, function(err, docpad) {
    if (err) {
        return docpadUtil.writeError(err);
    }
    return docpad.action(action, function(err) {
        if (err) {
            return docpadUtil.writeError(err);
        }
        return console.log('OK');
    });
});</code></pre>

</div>

    <div class="constructor">
        <h2>Constructor</h2>
<div id="method_Docpad" class="method item">
    <h3 class="name"><code>Docpad</code></h3>

        <span class="paren">()</span>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l118"><code>src&#x2F;lib&#x2F;docpad.coffee:118</code></a>
        </p>



    </div>

    <div class="description">
        
    </div>




</div>
    </div>

<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
            <li class="api-class-tab properties"><a href="#properties">Properties</a></li>
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods extends">
                            <li class="index-item method">
                                <a href="#method_action">action</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_addCollection">addCollection</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_addModel">addModel</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_addModels">addModels</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_attachModelEvents">attachModelEvents</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_checkRequest">checkRequest</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_clean">clean</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_compareVersion">compareVersion</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_constructor">constructor</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_contextualizeFiles">contextualizeFiles</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_createDocument">createDocument</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_createError">createError</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_createFile">createFile</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_createModel">createModel</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_createModels">createModels</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_createProgress">createProgress</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_createRegenerateTimer">createRegenerateTimer</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_destroy">destroy</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyBlocks">destroyBlocks</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_destroyCollection">destroyCollection</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyCollections">destroyCollections</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyDatabase">destroyDatabase</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyLoggers">destroyLoggers</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyPlugins">destroyPlugins</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyProgress">destroyProgress</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyRegenerateTimer">destroyRegenerateTimer</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyServer">destroyServer</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_destroyWatchers">destroyWatchers</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_eachBlock">eachBlock</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_eachCollection">eachCollection</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_emitParallel">emitParallel</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_emitSerial">emitSerial</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_error">error</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_extendCollections">extendCollections</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_fatal">fatal</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_fixNodePackageVersions">fixNodePackageVersions</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_generate">generate</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getActionRunner">getActionRunner</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getBlock">getBlock</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getBlocks">getBlocks</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getCollection">getCollection</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getCollections">getCollections</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getConfig">getConfig</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_getConfigPath">getConfigPath</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getDatabase">getDatabase</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getDatabaseSafe">getDatabaseSafe</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getDebugging">getDebugging</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getEnvironment">getEnvironment</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getEnvironments">getEnvironments</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getErrorRunner">getErrorRunner</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getEvents">getEvents</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_getExchange">getExchange</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFile">getFile</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFileAtPath">getFileAtPath</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFileById">getFileById</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFileByRoute">getFileByRoute</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFileBySelector">getFileBySelector</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFileByUrl">getFileByUrl</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFiles">getFiles</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getFilesAtPath">getFilesAtPath</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getHostname">getHostname</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getIgnoreOpts">getIgnoreOpts</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getLocale">getLocale</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getLogger">getLogger</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getLoggers">getLoggers</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getLogLevel">getLogLevel</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getPlugin">getPlugin</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getPort">getPort</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getProcessPlatform">getProcessPlatform</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getProcessVersion">getProcessVersion</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getServer">getServer</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getServerUrl">getServerUrl</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getSimpleServerUrl">getSimpleServerUrl</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getSkeletons">getSkeletons</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getTemplateData">getTemplateData</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getTrackRunner">getTrackRunner</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getUrlPathname">getUrlPathname</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getVersion">getVersion</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getVersionString">getVersionString</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_hasPlugins">hasPlugins</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_identify">identify</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_init">init</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_initGitRepo">initGitRepo</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_initInstall">initInstall</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_initNodeModules">initNodeModules</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_initSkeleton">initSkeleton</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_inspector">inspector</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_install">install</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_installNodeModule">installNodeModule</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_installSkeleton">installSkeleton</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_isIgnoredPath">isIgnoredPath</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_load">load</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_loadAndRenderDocument">loadAndRenderDocument</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_loadConfigPath">loadConfigPath</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_loadConfigUrl">loadConfigUrl</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_loadDocument">loadDocument</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_loadedPlugin">loadedPlugin</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_loadLocale">loadLocale</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_loadPlugin">loadPlugin</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_loadPlugins">loadPlugins</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_loadPluginsIn">loadPluginsIn</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_logError">logError</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_mergeConfigurations">mergeConfigurations</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_notify">notify</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_notifyError">notifyError</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_parseDirectory">parseDirectory</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_parseDocumentDirectory">parseDocumentDirectory</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_parseFileDirectory">parseFileDirectory</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_ready">ready</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_render">render</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_renderData">renderData</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_renderDocument">renderDocument</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_renderFiles">renderFiles</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_renderPath">renderPath</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_renderText">renderText</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_resetCollections">resetCollections</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_run">run</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_scandir">scandir</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_selectSkeleton">selectSkeleton</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_serveDocument">serveDocument</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_server">server</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_serverMiddleware404">serverMiddleware404</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_serverMiddleware500">serverMiddleware500</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_serverMiddlewareHeader">serverMiddlewareHeader</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_serverMiddlewareRouter">serverMiddlewareRouter</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_setBlock">setBlock</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_setBlocks">setBlocks</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_setCollection">setCollection</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_setCollections">setCollections</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_setConfig">setConfig</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_setInstanceConfig">setInstanceConfig</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_setLoggers">setLoggers</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_setLogLevel">setLogLevel</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_setServer">setServer</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_skeleton">skeleton</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_skeletonEmpty">skeletonEmpty</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_subscribe">subscribe</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_track">track</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_trackError">trackError</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_uninstall">uninstall</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_uninstallNodeModule">uninstallNodeModule</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_update">update</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_updateUserConfig">updateUserConfig</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_upgrade">upgrade</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_useSkeleton">useSkeleton</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_warn">warn</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_watch">watch</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_watchdir">watchdir</a>

                            </li>
                            <li class="index-item method private">
                                <a href="#method_writeFiles">writeFiles</a>

                            </li>
                    </ul>
                </div>

                <div class="index-section properties">
                    <h3>Properties</h3>

                    <ul class="index-list properties extends">
                            <li class="index-item property private">
                                <a href="#property_actionRunnerInstance">actionRunnerInstance</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_BasePlugin">BasePlugin</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_blocks">blocks</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_Collection">Collection</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_collections">collections</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_config">config</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_corePath">corePath</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_database">database</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_databaseTempCache FileCollection of models">databaseTempCache FileCollection of models</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_debugLogPath">debugLogPath</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_DocumentModel">DocumentModel</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_ElementsCollection">ElementsCollection</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_errorRunnerInstance">errorRunnerInstance</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_Events">Events</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_exchange">exchange</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_FileModel">FileModel</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_filesByOutPath">filesByOutPath</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_filesBySelector">filesBySelector</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_filesByUrl">filesByUrl</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_FilesCollection">FilesCollection</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_generated">generated</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_generateEnded">generateEnded</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_generateStarted">generateStarted</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_generating">generating</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_initialConfig">initialConfig</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_initialTemplateData">initialTemplateData</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_instanceConfig">instanceConfig</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_libPath">libPath</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_loadedPlugins">loadedPlugins</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_locale">locale</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_localePath">localePath</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_log">log</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_loggerInstances">loggerInstances</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_mainPath">mainPath</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_MetaCollection">MetaCollection</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_Model">Model</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_packagePath">packagePath</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_PluginLoader">PluginLoader</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_pluginsTemplateData">pluginsTemplateData</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_pluginVersion">pluginVersion</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_QueryCollection">QueryCollection</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_regenerateTimer">regenerateTimer</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_ScriptsCollection">ScriptsCollection</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_serverExpress">serverExpress</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_serverHttp">serverHttp</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_skeletonsCollection">skeletonsCollection</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_slowPlugins">slowPlugins</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_string array of event names">string array of event names</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_string constant">string constant</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_StylesCollection">StylesCollection</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_trackRunnerInstance">trackRunnerInstance</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_userConfig">userConfig</a>

                            </li>
                            <li class="index-item property">
                                <a href="#property_userConfigPath">userConfigPath</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_version">version</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_watchers">watchers</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_websiteConfig">websiteConfig</a>

                            </li>
                            <li class="index-item property private">
                                <a href="#property_websitePackageConfig">websitePackageConfig</a>

                            </li>
                    </ul>
                </div>


        </div>

            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

<div id="method_action" class="method item">
    <h3 class="name"><code>action</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>args</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l461"><code>src&#x2F;lib&#x2F;docpad.coffee:461</code></a>
        </p>



    </div>

    <div class="description">
        <p>Apply the passed DocPad action arguments</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">args</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
            </div>
        </div>


</div>
<div id="method_addCollection" class="method item">
    <h3 class="name"><code>addCollection</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>collection</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l763"><code>src&#x2F;lib&#x2F;docpad.coffee:763</code></a>
        </p>



    </div>

    <div class="description">
        <p>Add a collection</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">collection</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_addModel" class="method item">
    <h3 class="name"><code>addModel</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>model</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3749"><code>src&#x2F;lib&#x2F;docpad.coffee:3749</code></a>
        </p>



    </div>

    <div class="description">
        <p>Add supplied model to the DocPad database. If the passed
model definition is a plain object of properties, a new
model will be created prior to adding to the database.
Calls DocPad/createModel:method
before adding the model to the database.</p>
<pre class="code prettyprint"><code># Override the stat's mtime to now
# This is because renames will not update the mtime
fileCurrentStat?.mtime = new Date()

# Create the file object
file = docpad.addModel({fullPath:filePath, stat:fileCurrentStat})</code></pre>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">model</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                        <p>either a plain object defining the required properties, in particular
the file path or an actual model object</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the model</p>

            </div>
        </div>


</div>
<div id="method_addModels" class="method item">
    <h3 class="name"><code>addModels</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>models</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3774"><code>src&#x2F;lib&#x2F;docpad.coffee:3774</code></a>
        </p>



    </div>

    <div class="description">
        <p>Add the supplied collection of models to the DocPad database.
Calls DocPad/createModels:method
before adding the models to the database.</p>
<pre class="code prettyprint"><code>databaseData = JSON.parse data.toString()
models = docpad.addModels(databaseData.models)</code></pre>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">models</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                        <p>DocPad collection of models</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the models</p>

            </div>
        </div>


</div>
<div id="method_attachModelEvents" class="method item private">
    <h3 class="name"><code>attachModelEvents</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>model</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3690"><code>src&#x2F;lib&#x2F;docpad.coffee:3690</code></a>
        </p>



    </div>

    <div class="description">
        <p>Attach events to a document model.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">model</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_checkRequest" class="method item private">
    <h3 class="name"><code>checkRequest</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3421"><code>src&#x2F;lib&#x2F;docpad.coffee:3421</code></a>
        </p>



    </div>

    <div class="description">
        <p>Check Request</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">res</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_clean" class="method item private">
    <h3 class="name"><code>clean</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5803"><code>src&#x2F;lib&#x2F;docpad.coffee:5803</code></a>
        </p>



    </div>

    <div class="description">
        <p>DocPad cleanup tasks.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>description</p>

            </div>
        </div>


</div>
<div id="method_compareVersion" class="method item private">
    <h3 class="name"><code>compareVersion</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4231"><code>src&#x2F;lib&#x2F;docpad.coffee:4231</code></a>
        </p>



    </div>

    <div class="description">
        <p>Compare current DocPad version to the latest
and print out the result to the console.
Used at startup.</p>

    </div>




</div>
<div id="method_constructor" class="method item">
    <h3 class="name"><code>constructor</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>instanceConfig</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1807"><code>src&#x2F;lib&#x2F;docpad.coffee:1807</code></a>
        </p>



    </div>

    <div class="description">
        <p>Constructor method. Sets up the DocPad instance.
next(err)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">instanceConfig</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                        <p>callback</p>

                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_contextualizeFiles" class="method item private">
    <h3 class="name"><code>contextualizeFiles</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4318"><code>src&#x2F;lib&#x2F;docpad.coffee:4318</code></a>
        </p>



    </div>

    <div class="description">
        <p>Contextualize files.
Contextualizing is the process of adding layouts and
awareness of other documents to our document. The
contextualizeBefore and contextualizeAfter events
are emitted here.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_createDocument" class="method item">
    <h3 class="name"><code>createDocument</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[attrs={}]</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3631"><code>src&#x2F;lib&#x2F;docpad.coffee:3631</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create document model. Calls
DocPad/createModel:method
with the 'document' modelType.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[attrs={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>DocumentModel</p>

            </div>
        </div>


</div>
<div id="method_createError" class="method item">
    <h3 class="name"><code>createError</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>err</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3239"><code>src&#x2F;lib&#x2F;docpad.coffee:3239</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create an error object</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the error</p>

            </div>
        </div>


</div>
<div id="method_createFile" class="method item">
    <h3 class="name"><code>createFile</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[attrs={}]</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3618"><code>src&#x2F;lib&#x2F;docpad.coffee:3618</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create file model. Calls
DocPad/createModel:method
with the 'file' modelType.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[attrs={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>FileModel</p>

            </div>
        </div>


</div>
<div id="method_createModel" class="method item">
    <h3 class="name"><code>createModel</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[attrs={}]</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3808"><code>src&#x2F;lib&#x2F;docpad.coffee:3808</code></a>
        </p>



    </div>

    <div class="description">
        <p>Creates either a file or document model.
The model type to be created can be passed
as an opts property, if not, the method will
attempt to determing the model type by checking
if the file is in one of the documents or
layout paths.</p>
<p>Ensures a duplicate model is not created
and all required attributes are present and
events attached.</p>
<p>Generally it is not necessary for an application
to manually create a model via creatModel as DocPad
will handle this process when watching a project's
file and document directories. However, it is possible
that a plugin might have a requirement to do so.</p>
<pre class="code prettyprint"><code>model = @docpad.createModel({fullPath:fullPath})
</code></pre>
<p>model.load()</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[attrs={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">fullPath</code>
                                    <span class="type">String</span>

                                <div class="param-description">
                                    <p>the full path to the file</p>

                                </div>

                            </li>
                        </ul>
                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">modelType</code>
                                    <span class="type">String</span>

                                <div class="param-description">
                                    <p>either 'file' or 'document'</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the file or document model</p>

            </div>
        </div>


</div>
<div id="method_createModels" class="method item private">
    <h3 class="name"><code>createModels</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>models</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3792"><code>src&#x2F;lib&#x2F;docpad.coffee:3792</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create a collection of models from the supplied collection
ensuring that the collection is suitable for adding to the
DocPad database. The method calls DocPad/createModel
for each model in the models array.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">models</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                        <p>DocPad collection of models</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the models</p>

            </div>
        </div>


</div>
<div id="method_createProgress" class="method item private">
    <h3 class="name"><code>createProgress</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4648"><code>src&#x2F;lib&#x2F;docpad.coffee:4648</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create the console progress bar.
Progress only shown if the DocPad config 'progress'
option is true, the DocPad config 'prompts' option is true
and the log level is 6 (default)</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the progress object</p>

            </div>
        </div>


</div>
<div id="method_createRegenerateTimer" class="method item private">
    <h3 class="name"><code>createRegenerateTimer</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4710"><code>src&#x2F;lib&#x2F;docpad.coffee:4710</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create the regeneration timer</p>

    </div>




</div>
<div id="method_destroy" class="method item">
    <h3 class="name"><code>destroy</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2053"><code>src&#x2F;lib&#x2F;docpad.coffee:2053</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy the DocPad instance
This is an action, and should be called as such
E.g. docpad.action('destroy', next)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_destroyBlocks" class="method item private">
    <h3 class="name"><code>destroyBlocks</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l686"><code>src&#x2F;lib&#x2F;docpad.coffee:686</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy all blocks</p>

    </div>




</div>
<div id="method_destroyCollection" class="method item">
    <h3 class="name"><code>destroyCollection</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>value</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l737"><code>src&#x2F;lib&#x2F;docpad.coffee:737</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destroy a collection by collection name or key</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">value</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>description</p>

            </div>
        </div>


</div>
<div id="method_destroyCollections" class="method item private">
    <h3 class="name"><code>destroyCollections</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l845"><code>src&#x2F;lib&#x2F;docpad.coffee:845</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy the DocPad project's collections.</p>

    </div>




</div>
<div id="method_destroyDatabase" class="method item private">
    <h3 class="name"><code>destroyDatabase</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l577"><code>src&#x2F;lib&#x2F;docpad.coffee:577</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy the DocPad database</p>

    </div>




</div>
<div id="method_destroyLoggers" class="method item private">
    <h3 class="name"><code>destroyLoggers</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l436"><code>src&#x2F;lib&#x2F;docpad.coffee:436</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy the caterpillar logger instances bound to DocPad</p>

    </div>




</div>
<div id="method_destroyPlugins" class="method item private">
    <h3 class="name"><code>destroyPlugins</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4005"><code>src&#x2F;lib&#x2F;docpad.coffee:4005</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy plugins</p>

    </div>




</div>
<div id="method_destroyProgress" class="method item private">
    <h3 class="name"><code>destroyProgress</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>progress</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4677"><code>src&#x2F;lib&#x2F;docpad.coffee:4677</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy the progress object</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">progress</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the progress object</p>

            </div>
        </div>


</div>
<div id="method_destroyRegenerateTimer" class="method item private">
    <h3 class="name"><code>destroyRegenerateTimer</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4693"><code>src&#x2F;lib&#x2F;docpad.coffee:4693</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy the regeneration timer.</p>

    </div>




</div>
<div id="method_destroyServer" class="method item private">
    <h3 class="name"><code>destroyServer</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l389"><code>src&#x2F;lib&#x2F;docpad.coffee:389</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Close and destroy the node.js http server</p>

    </div>




</div>
<div id="method_destroyWatchers" class="method item private">
    <h3 class="name"><code>destroyWatchers</code></h3>

        <span class="paren">()</span>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5318"><code>src&#x2F;lib&#x2F;docpad.coffee:5318</code></a>
        </p>



    </div>

    <div class="description">
        <p>Destructor. Destroy the watchers used
by DocPad</p>

    </div>




</div>
<div id="method_eachBlock" class="method item">
    <h3 class="name"><code>eachBlock</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>fn</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l677"><code>src&#x2F;lib&#x2F;docpad.coffee:677</code></a>
        </p>



    </div>

    <div class="description">
        <p>Apply the passed function to each block</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">fn</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_eachCollection" class="method item">
    <h3 class="name"><code>eachCollection</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>fn</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l834"><code>src&#x2F;lib&#x2F;docpad.coffee:834</code></a>
        </p>



    </div>

    <div class="description">
        <p>Apply the passed function to each collection</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">fn</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_emitParallel" class="method item private">
    <h3 class="name"><code>emitParallel</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>eventName</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2143"><code>src&#x2F;lib&#x2F;docpad.coffee:2143</code></a>
        </p>



    </div>

    <div class="description">
        <p>Emit event, parallel</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">eventName</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_emitSerial" class="method item private">
    <h3 class="name"><code>emitSerial</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>eventName</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2111"><code>src&#x2F;lib&#x2F;docpad.coffee:2111</code></a>
        </p>



    </div>

    <div class="description">
        <p>Emit event, serial</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">eventName</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_error" class="method item">
    <h3 class="name"><code>error</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>err</code>
                </li>
                <li class="arg">
                        <code class="optional">[level=&#x27;err&#x27;]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3273"><code>src&#x2F;lib&#x2F;docpad.coffee:3273</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create an error (tracks it) and log it</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[level=&#x27;err&#x27;]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_extendCollections" class="method item private">
    <h3 class="name"><code>extendCollections</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2760"><code>src&#x2F;lib&#x2F;docpad.coffee:2760</code></a>
        </p>



    </div>

    <div class="description">
        <p>Extend collecitons. Create DocPad's
standard (documents, files
layouts) and special (generate, referencesOthers,
hasLayout, html, stylesheet) collections. Set blocks</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_fatal" class="method item private">
    <h3 class="name"><code>fatal</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>err</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3185"><code>src&#x2F;lib&#x2F;docpad.coffee:3185</code></a>
        </p>



    </div>

    <div class="description">
        <p>Handle a fatal error</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_fixNodePackageVersions" class="method item private">
    <h3 class="name"><code>fixNodePackageVersions</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3000"><code>src&#x2F;lib&#x2F;docpad.coffee:3000</code></a>
        </p>



    </div>

    <div class="description">
        <p>Fix node package versions
Combat to <a href="https://github.com/npm/npm/issues/4587#issuecomment-35370453">https://github.com/npm/npm/issues/4587#issuecomment-35370453</a></p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_generate" class="method item">
    <h3 class="name"><code>generate</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4733"><code>src&#x2F;lib&#x2F;docpad.coffee:4733</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set off DocPad's generation process.
The generated, populateCollectionsBefore, populateCollections, populateCollections
generateBefore and generateAfter events are emitted here</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_getActionRunner" class="method item">
    <h3 class="name"><code>getActionRunner</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l454"><code>src&#x2F;lib&#x2F;docpad.coffee:454</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the action runner instance bound to docpad</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the action runner instance</p>

            </div>
        </div>


</div>
<div id="method_getBlock" class="method item">
    <h3 class="name"><code>getBlock</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code class="optional">[clone]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l629"><code>src&#x2F;lib&#x2F;docpad.coffee:629</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a block by block name. Optionally clone block.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[clone]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>block</p>

            </div>
        </div>


</div>
<div id="method_getBlocks" class="method item">
    <h3 class="name"><code>getBlocks</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l660"><code>src&#x2F;lib&#x2F;docpad.coffee:660</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get all blocks</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>collection of blocks</p>

            </div>
        </div>


</div>
<div id="method_getCollection" class="method item">
    <h3 class="name"><code>getCollection</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>value</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l705"><code>src&#x2F;lib&#x2F;docpad.coffee:705</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a collection by collection name or key.
This is often accessed within the docpad.coffee
file or a layout/page via @getCollection.
Because getCollection returns a docpad collection,
a call to this method is often chained with a
QueryEngine style query.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">value</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>collection</p>

            </div>
        </div>


</div>
<div id="method_getCollections" class="method item">
    <h3 class="name"><code>getCollections</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l813"><code>src&#x2F;lib&#x2F;docpad.coffee:813</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the DocPad project's collections</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the collections</p>

            </div>
        </div>


</div>
<div id="method_getConfig" class="method item">
    <h3 class="name"><code>getConfig</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1736"><code>src&#x2F;lib&#x2F;docpad.coffee:1736</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the DocPad configuration. Commonly
called within the docpad.coffee file or within
plugins to access application specific configurations.
serverExtend: (opts) -&gt;
Extract the server from the options
{server} = opts
docpad = @docpad</p>
<p>As we are now running in an event,
ensure we are using the latest copy of the docpad configuraiton
and fetch our urls from it
latestConfig = docpad.getConfig()
oldUrls = latestConfig.templateData.site.oldUrls or []
newUrl = latestConfig.templateData.site.url</p>
<p>Redirect any requests accessing one of our sites oldUrls to the new site url
server.use (req,res,next) -&gt;
...</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the DocPad configuration object</p>

            </div>
        </div>


</div>
<div id="method_getConfigPath" class="method item private">
    <h3 class="name"><code>getConfigPath</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2717"><code>src&#x2F;lib&#x2F;docpad.coffee:2717</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get config paths and check that those
paths exist</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">path</code>
                                    <span class="type">String</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_getDatabase" class="method item">
    <h3 class="name"><code>getDatabase</code></h3>

        <span class="paren">()</span>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l562"><code>src&#x2F;lib&#x2F;docpad.coffee:562</code></a>
        </p>



    </div>

    <div class="description">
        <p>Description for getDatabase</p>

    </div>




</div>
<div id="method_getDatabaseSafe" class="method item">
    <h3 class="name"><code>getDatabaseSafe</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l568"><code>src&#x2F;lib&#x2F;docpad.coffee:568</code></a>
        </p>



    </div>

    <div class="description">
        <p>Safe method for retrieving the database by
either returning the database itself or the temporary
database cache</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
            </div>
        </div>


</div>
<div id="method_getDebugging" class="method item">
    <h3 class="name"><code>getDebugging</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3176"><code>src&#x2F;lib&#x2F;docpad.coffee:3176</code></a>
        </p>



    </div>

    <div class="description">
        <p>Are we debugging?</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Boolean</span>:
            </div>
        </div>


</div>
<div id="method_getEnvironment" class="method item">
    <h3 class="name"><code>getEnvironment</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1335"><code>src&#x2F;lib&#x2F;docpad.coffee:1335</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the DocPad environment, eg: development,
production or static</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
                    <p>the environment</p>

            </div>
        </div>


</div>
<div id="method_getEnvironments" class="method item">
    <h3 class="name"><code>getEnvironments</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Array</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1345"><code>src&#x2F;lib&#x2F;docpad.coffee:1345</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the environments</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Array</span>:
                    <p>array of environment strings</p>

            </div>
        </div>


</div>
<div id="method_getErrorRunner" class="method item">
    <h3 class="name"><code>getErrorRunner</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l476"><code>src&#x2F;lib&#x2F;docpad.coffee:476</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the error runner instance</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the error runner instance</p>

            </div>
        </div>


</div>
<div id="method_getEvents" class="method item">
    <h3 class="name"><code>getEvents</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l533"><code>src&#x2F;lib&#x2F;docpad.coffee:533</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the list of available events</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>string array of event names</p>

            </div>
        </div>


</div>
<div id="method_getExchange" class="method item private">
    <h3 class="name"><code>getExchange</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4270"><code>src&#x2F;lib&#x2F;docpad.coffee:4270</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get DocPad's exchange data
Requires internet access
next(err,exchange)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">exchange</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>docpad.exchange</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_getFile" class="method item">
    <h3 class="name"><code>getFile</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>query</code>
                </li>
                <li class="arg">
                        <code>sorting</code>
                </li>
                <li class="arg">
                        <code>paging</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l879"><code>src&#x2F;lib&#x2F;docpad.coffee:879</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a single file based on a query</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">query</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">sorting</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">paging</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>a file</p>

            </div>
        </div>


</div>
<div id="method_getFileAtPath" class="method item">
    <h3 class="name"><code>getFileAtPath</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>path</code>
                </li>
                <li class="arg">
                        <code>sorting</code>
                </li>
                <li class="arg">
                        <code>paging</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l904"><code>src&#x2F;lib&#x2F;docpad.coffee:904</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a file at a relative or absolute path or url</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">path</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">sorting</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">paging</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>a file</p>

            </div>
        </div>


</div>
<div id="method_getFileById" class="method item">
    <h3 class="name"><code>getFileById</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>id</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l931"><code>src&#x2F;lib&#x2F;docpad.coffee:931</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a file by its id</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">id</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>a file</p>

            </div>
        </div>


</div>
<div id="method_getFileByRoute" class="method item">
    <h3 class="name"><code>getFileByRoute</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>url</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l954"><code>src&#x2F;lib&#x2F;docpad.coffee:954</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a file by its route and return
it to the supplied callback.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">url</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">file</code>
                                    <span class="type">String</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_getFileBySelector" class="method item">
    <h3 class="name"><code>getFileBySelector</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>selector</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l996"><code>src&#x2F;lib&#x2F;docpad.coffee:996</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a file by its selector</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">selector</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>a file</p>

            </div>
        </div>


</div>
<div id="method_getFileByUrl" class="method item">
    <h3 class="name"><code>getFileByUrl</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>url</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l918"><code>src&#x2F;lib&#x2F;docpad.coffee:918</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a file by its url</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">url</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>a file</p>

            </div>
        </div>


</div>
<div id="method_getFiles" class="method item">
    <h3 class="name"><code>getFiles</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>query</code>
                </li>
                <li class="arg">
                        <code>sorting</code>
                </li>
                <li class="arg">
                        <code>paging</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l861"><code>src&#x2F;lib&#x2F;docpad.coffee:861</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get all the files in the DocPad database (will use live collections)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">query</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">sorting</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">paging</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>collection</p>

            </div>
        </div>


</div>
<div id="method_getFilesAtPath" class="method item">
    <h3 class="name"><code>getFilesAtPath</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>path</code>
                </li>
                <li class="arg">
                        <code>sorting</code>
                </li>
                <li class="arg">
                        <code>paging</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l891"><code>src&#x2F;lib&#x2F;docpad.coffee:891</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get files at a path</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">path</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">sorting</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">paging</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>files</p>

            </div>
        </div>


</div>
<div id="method_getHostname" class="method item">
    <h3 class="name"><code>getHostname</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1769"><code>src&#x2F;lib&#x2F;docpad.coffee:1769</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the Hostname</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
            </div>
        </div>


</div>
<div id="method_getIgnoreOpts" class="method item">
    <h3 class="name"><code>getIgnoreOpts</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Array</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2179"><code>src&#x2F;lib&#x2F;docpad.coffee:2179</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the ignore options for the DocPad project</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Array</span>:
                    <p>string array of ignore options</p>

            </div>
        </div>


</div>
<div id="method_getLocale" class="method item">
    <h3 class="name"><code>getLocale</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1286"><code>src&#x2F;lib&#x2F;docpad.coffee:1286</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the locale (language code and locale code)</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>locale</p>

            </div>
        </div>


</div>
<div id="method_getLogger" class="method item">
    <h3 class="name"><code>getLogger</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l407"><code>src&#x2F;lib&#x2F;docpad.coffee:407</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the caterpillar logger instance bound to DocPad</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>caterpillar logger</p>

            </div>
        </div>


</div>
<div id="method_getLoggers" class="method item">
    <h3 class="name"><code>getLoggers</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l414"><code>src&#x2F;lib&#x2F;docpad.coffee:414</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get all the caterpillar logger instances bound to DocPad</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>collection of caterpillar loggers</p>

            </div>
        </div>


</div>
<div id="method_getLogLevel" class="method item">
    <h3 class="name"><code>getLogLevel</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Number</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3168"><code>src&#x2F;lib&#x2F;docpad.coffee:3168</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the log level</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Number</span>:
                    <p>the log level</p>

            </div>
        </div>


</div>
<div id="method_getPlugin" class="method item">
    <h3 class="name"><code>getPlugin</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>pluginName</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3987"><code>src&#x2F;lib&#x2F;docpad.coffee:3987</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get a plugin by it's name</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">pluginName</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>a DocPad plugin</p>

            </div>
        </div>


</div>
<div id="method_getPort" class="method item">
    <h3 class="name"><code>getPort</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Number</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1761"><code>src&#x2F;lib&#x2F;docpad.coffee:1761</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the port that DocPad is listening on (eg 9778)</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Number</span>:
                    <p>the port number</p>

            </div>
        </div>


</div>
<div id="method_getProcessPlatform" class="method item">
    <h3 class="name"><code>getProcessPlatform</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l328"><code>src&#x2F;lib&#x2F;docpad.coffee:328</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the process platform</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
            </div>
        </div>


</div>
<div id="method_getProcessVersion" class="method item">
    <h3 class="name"><code>getProcessVersion</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l335"><code>src&#x2F;lib&#x2F;docpad.coffee:335</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the process version string</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
            </div>
        </div>


</div>
<div id="method_getServer" class="method item">
    <h3 class="name"><code>getServer</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[both=false]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l358"><code>src&#x2F;lib&#x2F;docpad.coffee:358</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the DocPad express.js server instance and, optionally,
the node.js https server instance</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[both=false]</code>
                        <span class="type">Boolean</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
            </div>
        </div>


</div>
<div id="method_getServerUrl" class="method item">
    <h3 class="name"><code>getServerUrl</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1777"><code>src&#x2F;lib&#x2F;docpad.coffee:1777</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get address</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
            </div>
        </div>


</div>
<div id="method_getSimpleServerUrl" class="method item">
    <h3 class="name"><code>getSimpleServerUrl</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1792"><code>src&#x2F;lib&#x2F;docpad.coffee:1792</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get simple server URL (changes 0.0.0.0, ::, and ::1 to 127.0.0.1)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name optional">[simple=true]</code>
                                    <span class="type">Boolean</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
            </div>
        </div>


</div>
<div id="method_getSkeletons" class="method item">
    <h3 class="name"><code>getSkeletons</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1024"><code>src&#x2F;lib&#x2F;docpad.coffee:1024</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get Skeletons
Get all the available skeletons with their details and
return this collection to the supplied callback.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">skeletonsCollection</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>DocPad collection of skeletons</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>DocPad skeleton collection</p>

            </div>
        </div>


</div>
<div id="method_getTemplateData" class="method item">
    <h3 class="name"><code>getTemplateData</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>userTemplateData</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1161"><code>src&#x2F;lib&#x2F;docpad.coffee:1161</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get Complete Template Data</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">userTemplateData</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>templateData</p>

            </div>
        </div>


</div>
<div id="method_getTrackRunner" class="method item">
    <h3 class="name"><code>getTrackRunner</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l490"><code>src&#x2F;lib&#x2F;docpad.coffee:490</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the track runner instance</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the track runner instance</p>

            </div>
        </div>


</div>
<div id="method_getUrlPathname" class="method item">
    <h3 class="name"><code>getUrlPathname</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>url</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l944"><code>src&#x2F;lib&#x2F;docpad.coffee:944</code></a>
        </p>



    </div>

    <div class="description">
        <p>Remove the query string from a url
Pathname convention taken from document.location.pathname</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">url</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
            </div>
        </div>


</div>
<div id="method_getVersion" class="method item">
    <h3 class="name"><code>getVersion</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Number</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l301"><code>src&#x2F;lib&#x2F;docpad.coffee:301</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the DocPad version number</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Number</span>:
            </div>
        </div>


</div>
<div id="method_getVersionString" class="method item">
    <h3 class="name"><code>getVersionString</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l310"><code>src&#x2F;lib&#x2F;docpad.coffee:310</code></a>
        </p>



    </div>

    <div class="description">
        <p>Get the DocPad version string</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
            </div>
        </div>


</div>
<div id="method_hasPlugins" class="method item">
    <h3 class="name"><code>hasPlugins</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3997"><code>src&#x2F;lib&#x2F;docpad.coffee:3997</code></a>
        </p>



    </div>

    <div class="description">
        <p>Check if we have any plugins</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Boolean</span>:
            </div>
        </div>


</div>
<div id="method_identify" class="method item private">
    <h3 class="name"><code>identify</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3540"><code>src&#x2F;lib&#x2F;docpad.coffee:3540</code></a>
        </p>



    </div>

    <div class="description">
        <p>Identify DocPad user</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_init" class="method item private">
    <h3 class="name"><code>init</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6117"><code>src&#x2F;lib&#x2F;docpad.coffee:6117</code></a>
        </p>



    </div>

    <div class="description">
        <p>Initialize the project directory
with the basic skeleton.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>description</p>

            </div>
        </div>


</div>
<div id="method_initGitRepo" class="method item private">
    <h3 class="name"><code>initGitRepo</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2942"><code>src&#x2F;lib&#x2F;docpad.coffee:2942</code></a>
        </p>



    </div>

    <div class="description">
        <p>Initialise git repo</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">results</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_initInstall" class="method item private">
    <h3 class="name"><code>initInstall</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5583"><code>src&#x2F;lib&#x2F;docpad.coffee:5583</code></a>
        </p>



    </div>

    <div class="description">
        <p>Initialize the skeleton install process.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_initNodeModules" class="method item private">
    <h3 class="name"><code>initNodeModules</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2967"><code>src&#x2F;lib&#x2F;docpad.coffee:2967</code></a>
        </p>



    </div>

    <div class="description">
        <p>Init node modules</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">results</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_initSkeleton" class="method item private">
    <h3 class="name"><code>initSkeleton</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>skeletonModel</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5857"><code>src&#x2F;lib&#x2F;docpad.coffee:5857</code></a>
        </p>



    </div>

    <div class="description">
        <p>Initialize a Skeleton into to a Directory</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">skeletonModel</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_inspector" class="method item">
    <h3 class="name"><code>inspector</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>obj</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">String</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3212"><code>src&#x2F;lib&#x2F;docpad.coffee:3212</code></a>
        </p>



    </div>

    <div class="description">
        <p>Inspect. Converts object to JSON string. Wrapper around nodes util.inspect method.
Can't use the inspect namespace as for some silly reason it destroys everything</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">obj</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">String</span>:
                    <p>JSON string of passed object</p>

            </div>
        </div>


</div>
<div id="method_install" class="method item private">
    <h3 class="name"><code>install</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5669"><code>src&#x2F;lib&#x2F;docpad.coffee:5669</code></a>
        </p>



    </div>

    <div class="description">
        <p>Install a plugin</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_installNodeModule" class="method item private">
    <h3 class="name"><code>installNodeModule</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>names</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3029"><code>src&#x2F;lib&#x2F;docpad.coffee:3029</code></a>
        </p>



    </div>

    <div class="description">
        <p>Install node module. Same as running
'npm install' through the command line</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">names</code>
                        <span class="type">Array</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">result</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_installSkeleton" class="method item private">
    <h3 class="name"><code>installSkeleton</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>skeletonModel</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5957"><code>src&#x2F;lib&#x2F;docpad.coffee:5957</code></a>
        </p>



    </div>

    <div class="description">
        <p>Install a Skeleton into a Directory</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">skeletonModel</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_isIgnoredPath" class="method item">
    <h3 class="name"><code>isIgnoredPath</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>path</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Boolean</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2187"><code>src&#x2F;lib&#x2F;docpad.coffee:2187</code></a>
        </p>



    </div>

    <div class="description">
        <p>Is the supplied path ignored?</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">path</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Boolean</span>:
            </div>
        </div>


</div>
<div id="method_load" class="method item private">
    <h3 class="name"><code>load</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>instanceConfig</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2455"><code>src&#x2F;lib&#x2F;docpad.coffee:2455</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load the various configuration files from the
file system. Set the instanceConfig.
next(err,config)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">instanceConfig</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">config</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_loadAndRenderDocument" class="method item">
    <h3 class="name"><code>loadAndRenderDocument</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>document</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5138"><code>src&#x2F;lib&#x2F;docpad.coffee:5138</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load and render a document</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">document</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">document</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_loadConfigPath" class="method item private">
    <h3 class="name"><code>loadConfigPath</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2652"><code>src&#x2F;lib&#x2F;docpad.coffee:2652</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load the configuration from a file path
passed as one of the options (opts.configPath) or
from DocPad's configPaths</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">parsedData</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_loadConfigUrl" class="method item">
    <h3 class="name"><code>loadConfigUrl</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>configUrl</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2621"><code>src&#x2F;lib&#x2F;docpad.coffee:2621</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load a configuration url.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">configUrl</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">parsedData</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_loadDocument" class="method item private">
    <h3 class="name"><code>loadDocument</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>document</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5117"><code>src&#x2F;lib&#x2F;docpad.coffee:5117</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load a document</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">document</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">document</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_loadedPlugin" class="method item">
    <h3 class="name"><code>loadedPlugin</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>pluginName</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4060"><code>src&#x2F;lib&#x2F;docpad.coffee:4060</code></a>
        </p>



    </div>

    <div class="description">
        <p>Checks if a plugin was loaded succesfully.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">pluginName</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">loaded</code>
                                    <span class="type">Boolean</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_loadLocale" class="method item">
    <h3 class="name"><code>loadLocale</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>code</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1306"><code>src&#x2F;lib&#x2F;docpad.coffee:1306</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load the locale</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">code</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>locale</p>

            </div>
        </div>


</div>
<div id="method_loadPlugin" class="method item private">
    <h3 class="name"><code>loadPlugin</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>fileFullPath</code>
                </li>
                <li class="arg">
                        <code>_next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4079"><code>src&#x2F;lib&#x2F;docpad.coffee:4079</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load a plugin from its full file path
_next(err)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">fileFullPath</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">_next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>description</p>

            </div>
        </div>


</div>
<div id="method_loadPlugins" class="method item private">
    <h3 class="name"><code>loadPlugins</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4016"><code>src&#x2F;lib&#x2F;docpad.coffee:4016</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load plugins from the file system
next(err)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_loadPluginsIn" class="method item private">
    <h3 class="name"><code>loadPluginsIn</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>pluginsPath</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4176"><code>src&#x2F;lib&#x2F;docpad.coffee:4176</code></a>
        </p>



    </div>

    <div class="description">
        <p>Load plugins from a directory path</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">pluginsPath</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_logError" class="method item">
    <h3 class="name"><code>logError</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>err</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3298"><code>src&#x2F;lib&#x2F;docpad.coffee:3298</code></a>
        </p>



    </div>

    <div class="description">
        <p>Log an error</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_mergeConfigurations" class="method item private">
    <h3 class="name"><code>mergeConfigurations</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>configPackages</code>
                </li>
                <li class="arg">
                        <code>configsToMerge</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2312"><code>src&#x2F;lib&#x2F;docpad.coffee:2312</code></a>
        </p>



    </div>

    <div class="description">
        <p>Performs the merging of the passed configuration objects</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">configPackages</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">configsToMerge</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_notify" class="method item">
    <h3 class="name"><code>notify</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>message</code>
                </li>
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3403"><code>src&#x2F;lib&#x2F;docpad.coffee:3403</code></a>
        </p>



    </div>

    <div class="description">
        <p>Send a notify event to plugins (like growl)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">message</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_notifyError" class="method item private">
    <h3 class="name"><code>notifyError</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>err</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3353"><code>src&#x2F;lib&#x2F;docpad.coffee:3353</code></a>
        </p>



    </div>

    <div class="description">
        <p>Notify error</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_parseDirectory" class="method item">
    <h3 class="name"><code>parseDirectory</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3907"><code>src&#x2F;lib&#x2F;docpad.coffee:3907</code></a>
        </p>



    </div>

    <div class="description">
        <p>Parse a directory and return a
files collection</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">files</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>files collection</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_parseDocumentDirectory" class="method item">
    <h3 class="name"><code>parseDocumentDirectory</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3660"><code>src&#x2F;lib&#x2F;docpad.coffee:3660</code></a>
        </p>



    </div>

    <div class="description">
        <p>Parse the documents directory and
return a documents collection to
the passed callback.</p>
<p>The partials plugin (<a href="https://github.com/docpad/docpad-plugin-partials">https://github.com/docpad/docpad-plugin-partials</a>)
uses this method to load a collection of
files from the partials directory.</p>
<pre class="code prettyprint"><code>docpad.parseDocumentDirectory({path: config.partialsPath}, next)</code></pre>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name optional">[modelType=&#x27;document&#x27;]</code>
                                    <span class="type">String</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[collection=docpad.database]</code>
                                    <span class="type">Object</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[path]</code>
                                    <span class="type">Object</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">files</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>files collection of documents</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_parseFileDirectory" class="method item">
    <h3 class="name"><code>parseFileDirectory</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3645"><code>src&#x2F;lib&#x2F;docpad.coffee:3645</code></a>
        </p>



    </div>

    <div class="description">
        <p>Parse the files directory and
return a files collection to
the passed callback</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                        <p>callback</p>

                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">files</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>files collection</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_ready" class="method item private">
    <h3 class="name"><code>ready</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2247"><code>src&#x2F;lib&#x2F;docpad.coffee:2247</code></a>
        </p>



    </div>

    <div class="description">
        <p>DocPad is ready. Peforms the tasks needed after DocPad construction
and DocPad has loaded. Triggers the docpadReady event.
next(err,docpadInstance)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">docpadInstance</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_render" class="method item">
    <h3 class="name"><code>render</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5275"><code>src&#x2F;lib&#x2F;docpad.coffee:5275</code></a>
        </p>



    </div>

    <div class="description">
        <p>Render action
next(err,document,result)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_renderData" class="method item">
    <h3 class="name"><code>renderData</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>content</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5208"><code>src&#x2F;lib&#x2F;docpad.coffee:5208</code></a>
        </p>



    </div>

    <div class="description">
        <p>Render the passed content data as a
document. Required option, filename
(opts.filename)
next(err,result)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">content</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">result</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>the rendered document</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_renderDocument" class="method item">
    <h3 class="name"><code>renderDocument</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>document</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5162"><code>src&#x2F;lib&#x2F;docpad.coffee:5162</code></a>
        </p>



    </div>

    <div class="description">
        <p>Render a document</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">document</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">result</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">document</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_renderFiles" class="method item private">
    <h3 class="name"><code>renderFiles</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4399"><code>src&#x2F;lib&#x2F;docpad.coffee:4399</code></a>
        </p>



    </div>

    <div class="description">
        <p>Render the DocPad project's files.
The renderCollectionBefore, renderCollectionAfter,
renderBefore, renderAfter events are all emitted here.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_renderPath" class="method item">
    <h3 class="name"><code>renderPath</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>path</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5184"><code>src&#x2F;lib&#x2F;docpad.coffee:5184</code></a>
        </p>



    </div>

    <div class="description">
        <p>Render a document at a file path
next(err,result)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">path</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">result</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>the rendered document</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_renderText" class="method item private">
    <h3 class="name"><code>renderText</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>text</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5239"><code>src&#x2F;lib&#x2F;docpad.coffee:5239</code></a>
        </p>



    </div>

    <div class="description">
        <p>Render the passed text data as a
document. Required option, filename
(opts.filename)
next(err,result)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">text</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">result</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>the rendered content</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">document</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    <p>the rendered document model</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_resetCollections" class="method item private">
    <h3 class="name"><code>resetCollections</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2904"><code>src&#x2F;lib&#x2F;docpad.coffee:2904</code></a>
        </p>



    </div>

    <div class="description">
        <p>Reset collections. Perform a complete clean of our collections</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_run" class="method item">
    <h3 class="name"><code>run</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5518"><code>src&#x2F;lib&#x2F;docpad.coffee:5518</code></a>
        </p>



    </div>

    <div class="description">
        <p>Run an action</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_scandir" class="method item">
    <h3 class="name"><code>scandir</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2198"><code>src&#x2F;lib&#x2F;docpad.coffee:2198</code></a>
        </p>



    </div>

    <div class="description">
        <p>Scan directory</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_selectSkeleton" class="method item private">
    <h3 class="name"><code>selectSkeleton</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6029"><code>src&#x2F;lib&#x2F;docpad.coffee:6029</code></a>
        </p>



    </div>

    <div class="description">
        <p>Select a Skeleton</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">skeletonModel</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_serveDocument" class="method item private">
    <h3 class="name"><code>serveDocument</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6147"><code>src&#x2F;lib&#x2F;docpad.coffee:6147</code></a>
        </p>



    </div>

    <div class="description">
        <p>Serve a document</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_server" class="method item private">
    <h3 class="name"><code>server</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6350"><code>src&#x2F;lib&#x2F;docpad.coffee:6350</code></a>
        </p>



    </div>

    <div class="description">
        <p>Configure and start up the DocPad web server.
Http and express server is created, extended with
middleware, started up and begins listening.
The events serverBefore, serverExtend and
serverAfter emitted here.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_serverMiddleware404" class="method item private">
    <h3 class="name"><code>serverMiddleware404</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>req</code>
                </li>
                <li class="arg">
                        <code>res</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6299"><code>src&#x2F;lib&#x2F;docpad.coffee:6299</code></a>
        </p>



    </div>

    <div class="description">
        <p>Server Middleware: 404</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">req</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">res</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_serverMiddleware500" class="method item private">
    <h3 class="name"><code>serverMiddleware500</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>err</code>
                </li>
                <li class="arg">
                        <code>req</code>
                </li>
                <li class="arg">
                        <code>res</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6326"><code>src&#x2F;lib&#x2F;docpad.coffee:6326</code></a>
        </p>



    </div>

    <div class="description">
        <p>Server Middleware: 500</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">req</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">res</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_serverMiddlewareHeader" class="method item private">
    <h3 class="name"><code>serverMiddlewareHeader</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>req</code>
                </li>
                <li class="arg">
                        <code>res</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6240"><code>src&#x2F;lib&#x2F;docpad.coffee:6240</code></a>
        </p>



    </div>

    <div class="description">
        <p>Server Middleware: Header</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">req</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">res</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_serverMiddlewareRouter" class="method item private">
    <h3 class="name"><code>serverMiddlewareRouter</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>req</code>
                </li>
                <li class="arg">
                        <code>res</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6267"><code>src&#x2F;lib&#x2F;docpad.coffee:6267</code></a>
        </p>



    </div>

    <div class="description">
        <p>Server Middleware: Router</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">req</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">res</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_setBlock" class="method item">
    <h3 class="name"><code>setBlock</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>value</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l643"><code>src&#x2F;lib&#x2F;docpad.coffee:643</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set a block by name and value</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">value</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_setBlocks" class="method item">
    <h3 class="name"><code>setBlocks</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>blocks</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l667"><code>src&#x2F;lib&#x2F;docpad.coffee:667</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set all blocks</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">blocks</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_setCollection" class="method item">
    <h3 class="name"><code>setCollection</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code>collection</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l773"><code>src&#x2F;lib&#x2F;docpad.coffee:773</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set a name for a collection.
A collection can have multiple names</p>
<p>The partials plugin (<a href="https://github.com/docpad/docpad-plugin-partials">https://github.com/docpad/docpad-plugin-partials</a>)
creates a live collection and passes this to setCollection with
the name 'partials'.</p>
<pre class="code prettyprint"><code># Add our partials collection
docpad.setCollection('partials', database.createLiveChildCollection()
    .setQuery('isPartial', {
            $or:
                isPartial: true
                fullPath: $startsWith: config.partialsPath
    })
    .on('add', (model) -&gt;
        docpad.log('debug', util.format(locale.addingPartial, model.getFilePath()))
        model.setDefaults(
            isPartial: true
            render: false
            write: false
        )
    )
)</code></pre>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type">String</span>


                    <div class="param-description">
                        <p>the name to give to the collection</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">collection</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                        <p>a DocPad collection</p>

                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_setCollections" class="method item">
    <h3 class="name"><code>setCollections</code></h3>

        <span class="paren">()</span>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l821"><code>src&#x2F;lib&#x2F;docpad.coffee:821</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set the DocPad project's collections</p>

    </div>




</div>
<div id="method_setConfig" class="method item private">
    <h3 class="name"><code>setConfig</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>instanceConfig</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2354"><code>src&#x2F;lib&#x2F;docpad.coffee:2354</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set the DocPad configuration object.
Performs a number of tasks, including
merging the pass instanceConfig with DocPad's
other config objects.
next(err,config)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">instanceConfig</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">config</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_setInstanceConfig" class="method item private">
    <h3 class="name"><code>setInstanceConfig</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>instanceConfig</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2337"><code>src&#x2F;lib&#x2F;docpad.coffee:2337</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set the instance configuration
by merging the properties of the passed object
with the existing DocPad instanceConfig object</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">instanceConfig</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_setLoggers" class="method item">
    <h3 class="name"><code>setLoggers</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>loggers</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l421"><code>src&#x2F;lib&#x2F;docpad.coffee:421</code></a>
        </p>



    </div>

    <div class="description">
        <p>Sets the caterpillar logger instances bound to DocPad</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">loggers</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>logger instances bound to DocPad</p>

            </div>
        </div>


</div>
<div id="method_setLogLevel" class="method item private">
    <h3 class="name"><code>setLogLevel</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>level</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3148"><code>src&#x2F;lib&#x2F;docpad.coffee:3148</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set the log level</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">level</code>
                        <span class="type">Number</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_setServer" class="method item">
    <h3 class="name"><code>setServer</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>servers</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l372"><code>src&#x2F;lib&#x2F;docpad.coffee:372</code></a>
        </p>



    </div>

    <div class="description">
        <p>Set the express.js server and node.js http server
to bind to DocPad</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">servers</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_skeleton" class="method item private">
    <h3 class="name"><code>skeleton</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6086"><code>src&#x2F;lib&#x2F;docpad.coffee:6086</code></a>
        </p>



    </div>

    <div class="description">
        <p>Initialize the project directory
with the basic skeleton.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_skeletonEmpty" class="method item private">
    <h3 class="name"><code>skeletonEmpty</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>path</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l6058"><code>src&#x2F;lib&#x2F;docpad.coffee:6058</code></a>
        </p>



    </div>

    <div class="description">
        <p>Skeleton Empty?</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">path</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_subscribe" class="method item private">
    <h3 class="name"><code>subscribe</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3444"><code>src&#x2F;lib&#x2F;docpad.coffee:3444</code></a>
        </p>



    </div>

    <div class="description">
        <p>Subscribe to the DocPad email list.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_track" class="method item private">
    <h3 class="name"><code>track</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>name</code>
                </li>
                <li class="arg">
                        <code class="optional">[things={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3483"><code>src&#x2F;lib&#x2F;docpad.coffee:3483</code></a>
        </p>



    </div>

    <div class="description">
        <p>Track</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">name</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name optional">[things={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_trackError" class="method item private">
    <h3 class="name"><code>trackError</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>err</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3329"><code>src&#x2F;lib&#x2F;docpad.coffee:3329</code></a>
        </p>



    </div>

    <div class="description">
        <p>Track an error in the background</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>



</div>
<div id="method_uninstall" class="method item private">
    <h3 class="name"><code>uninstall</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5630"><code>src&#x2F;lib&#x2F;docpad.coffee:5630</code></a>
        </p>



    </div>

    <div class="description">
        <p>Uninstall a plugin.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_uninstallNodeModule" class="method item private">
    <h3 class="name"><code>uninstallNodeModule</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>names</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3092"><code>src&#x2F;lib&#x2F;docpad.coffee:3092</code></a>
        </p>



    </div>

    <div class="description">
        <p>Uninstall node module. Same as running
'npm uninstall' through the command line</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">names</code>
                        <span class="type">Array</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name">result</code>
                                    <span class="type">Object</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_update" class="method item private">
    <h3 class="name"><code>update</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5740"><code>src&#x2F;lib&#x2F;docpad.coffee:5740</code></a>
        </p>



    </div>

    <div class="description">
        <p>Update the local DocPad and plugin dependencies</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_updateUserConfig" class="method item">
    <h3 class="name"><code>updateUserConfig</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[data={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2589"><code>src&#x2F;lib&#x2F;docpad.coffee:2589</code></a>
        </p>



    </div>

    <div class="description">
        <p>Update user configuration with the passed data</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[data={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_upgrade" class="method item private">
    <h3 class="name"><code>upgrade</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5720"><code>src&#x2F;lib&#x2F;docpad.coffee:5720</code></a>
        </p>



    </div>

    <div class="description">
        <p>Update global NPM and DocPad</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>description</p>

            </div>
        </div>


</div>
<div id="method_useSkeleton" class="method item private">
    <h3 class="name"><code>useSkeleton</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>skeletonModel</code>
                </li>
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>


        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5985"><code>src&#x2F;lib&#x2F;docpad.coffee:5985</code></a>
        </p>



    </div>

    <div class="description">
        <p>Use a Skeleton</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">skeletonModel</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>description</p>

            </div>
        </div>


</div>
<div id="method_warn" class="method item">
    <h3 class="name"><code>warn</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>message</code>
                </li>
                <li class="arg">
                        <code>err</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3377"><code>src&#x2F;lib&#x2F;docpad.coffee:3377</code></a>
        </p>



    </div>

    <div class="description">
        <p>Log an error of level 'warn'</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">message</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">err</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>description</p>

            </div>
        </div>


</div>
<div id="method_watch" class="method item private">
    <h3 class="name"><code>watch</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>opts</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5340"><code>src&#x2F;lib&#x2F;docpad.coffee:5340</code></a>
        </p>



    </div>

    <div class="description">
        <p>Start up file watchers used by DocPad</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">opts</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
<div id="method_watchdir" class="method item">
    <h3 class="name"><code>watchdir</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l2210"><code>src&#x2F;lib&#x2F;docpad.coffee:2210</code></a>
        </p>



    </div>

    <div class="description">
        <p>Watch Directory. Wrapper around the Bevry watchr
module (<a href="https://github.com/bevry/watchr">https://github.com/bevry/watchr</a>). Used
internally by DocPad to watch project documents
and files and then activate the regeneration process
when any of those items are updated.</p>
<p>Although it is possible to pass a range of options to watchdir
in practice these options are provided as part of
the DocPad config object with a number of default options
specified in the DocPad config.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name optional">[path]</code>
                                    <span class="type">String</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>a single path to watch.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[paths]</code>
                                    <span class="type">Array</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>an array of paths to watch.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[listener]</code>
                                    <span class="type">Function</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>a single change listener to fire when a change occurs.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[listeners]</code>
                                    <span class="type">Array</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>an array of listeners.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[next]</code>
                                    <span class="type">Function</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>callback.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[stat]</code>
                                    <span class="type">Object</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>a file stat object to use for the path, instead of fetching a new one.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[interval=5007]</code>
                                    <span class="type">Number</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>for systems that poll to detect file changes, how often should it poll in millseconds.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[catupDelay=200]</code>
                                    <span class="type">Number</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>handles system swap file deletions and renaming</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[preferredMethods=[&#x27;watch&#x27;,&#x27;watchFile&#x27;]</code>
                                    <span class="type">Array</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>which order should we prefer our watching methods to be tried?.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[followLinks=true]</code>
                                    <span class="type">Boolean</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>follow symlinks, i.e. use stat rather than lstat.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[ignorePaths=false]</code>
                                    <span class="type">Boolean | Array</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>an array of full paths to ignore.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[ignoreHiddenFiles=false]</code>
                                    <span class="type">Boolean | Array</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>whether or not to ignored files which filename starts with a &quot;.&quot;.</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[ignoreCommonPatterns=true]</code>
                                    <span class="type">Boolean</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>whether or not to ignore common undesirable file patterns (e.g. .svn, .git, .DS_Store, thumbs.db, etc).</p>

                                </div>

                            </li>
                            <li class="param">
                                    <code class="param-name optional">[ignoreCustomPatterns=null]</code>
                                    <span class="type">Boolean | Array</span>
                                    <span class="flag optional" title="This parameter is optional.">optional</span>

                                <div class="param-description">
                                    <p>any custom ignore patterns that you would also like to ignore along with the common patterns.</p>

                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the watcher</p>

            </div>
        </div>


</div>
<div id="method_writeFiles" class="method item private">
    <h3 class="name"><code>writeFiles</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code class="optional">[opts={}]</code>
                </li>
                <li class="arg">
                        <code>next</code>
                </li>
            </ul><span class="paren">)</span>
        </div>



        <span class="flag private">private</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4523"><code>src&#x2F;lib&#x2F;docpad.coffee:4523</code></a>
        </p>



    </div>

    <div class="description">
        <p>Write rendered files to the DocPad out directory.
The writeBefore and writeAfter events are emitted here.</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name optional">[opts={}]</code>
                        <span class="type">Object</span>
                        <span class="flag optional" title="This parameter is optional.">optional</span>


                    <div class="param-description">
                         
                    </div>

                </li>
                <li class="param">
                        <code class="param-name">next</code>
                        <span class="type">Function</span>


                    <div class="param-description">
                         
                    </div>

                        <ul class="params-list">
                            <li class="param">
                                    <code class="param-name">err</code>
                                    <span class="type">Error</span>

                                <div class="param-description">
                                    
                                </div>

                            </li>
                        </ul>
                </li>
            </ul>
        </div>



</div>
            </div>

            <div id="properties" class="api-class-tabpanel">
                <h2 class="off-left">Properties</h2>

<div id="property_actionRunnerInstance" class="property item private">
    <h3 class="name"><code>actionRunnerInstance</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l447"><code>src&#x2F;lib&#x2F;docpad.coffee:447</code></a>
        </p>


    </div>

    <div class="description">
        <p>The action runner instance bound to docpad</p>

    </div>



</div>
<div id="property_BasePlugin" class="property item">
    <h3 class="name"><code>BasePlugin</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l284"><code>src&#x2F;lib&#x2F;docpad.coffee:284</code></a>
        </p>


    </div>

    <div class="description">
        <p>Base class for all DocPad plugins
<a href="https://github.com/docpad/docpad/blob/master/src/lib/plugin.coffee">https://github.com/docpad/docpad/blob/master/src/lib/plugin.coffee</a></p>

    </div>



</div>
<div id="property_blocks" class="property item private">
    <h3 class="name"><code>blocks</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l612"><code>src&#x2F;lib&#x2F;docpad.coffee:612</code></a>
        </p>


    </div>

    <div class="description">
        <p>Blocks</p>

    </div>



</div>
<div id="property_Collection" class="property item">
    <h3 class="name"><code>Collection</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l195"><code>src&#x2F;lib&#x2F;docpad.coffee:195</code></a>
        </p>


    </div>

    <div class="description">
        <p>Collection class
Extension of the Backbone Collection class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/base.coffee">https://github.com/docpad/docpad/blob/master/src/lib/base.coffee</a>
<a href="http://backbonejs.org/#Collection">http://backbonejs.org/#Collection</a></p>

    </div>



</div>
<div id="property_collections" class="property item private">
    <h3 class="name"><code>collections</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l698"><code>src&#x2F;lib&#x2F;docpad.coffee:698</code></a>
        </p>


    </div>

    <div class="description">
        <p>The DocPad collections</p>

    </div>



</div>
<div id="property_config" class="property item private">
    <h3 class="name"><code>config</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1374"><code>src&#x2F;lib&#x2F;docpad.coffee:1374</code></a>
        </p>


    </div>

    <div class="description">
        <p>Merged Configuration
Merged in the order of:</p>
<ul>
<li>initialConfig</li>
<li>userConfig</li>
<li>websiteConfig</li>
<li>instanceConfig</li>
<li>environmentConfig
Use getConfig to retrieve this value</li>
</ul>

    </div>



</div>
<div id="property_corePath" class="property item">
    <h3 class="name"><code>corePath</code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1100"><code>src&#x2F;lib&#x2F;docpad.coffee:1100</code></a>
        </p>


    </div>

    <div class="description">
        <p>The DocPad directory</p>

    </div>



</div>
<div id="property_database" class="property item private">
    <h3 class="name"><code>database</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l547"><code>src&#x2F;lib&#x2F;docpad.coffee:547</code></a>
        </p>


    </div>

    <div class="description">
        <p>QueryEngine collection</p>

    </div>



</div>
<div id="property_databaseTempCache FileCollection of models" class="property item private">
    <h3 class="name"><code>databaseTempCache FileCollection of models</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l554"><code>src&#x2F;lib&#x2F;docpad.coffee:554</code></a>
        </p>


    </div>

    <div class="description">
        <p>A FilesCollection of models updated
from the DocPad database after each regeneration.</p>

    </div>



</div>
<div id="property_debugLogPath" class="property item">
    <h3 class="name"><code>debugLogPath</code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1131"><code>src&#x2F;lib&#x2F;docpad.coffee:1131</code></a>
        </p>


    </div>

    <div class="description">
        <p>The DocPad debug log path (docpad-debug.log)</p>

    </div>



</div>
<div id="property_DocumentModel" class="property item">
    <h3 class="name"><code>DocumentModel</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l224"><code>src&#x2F;lib&#x2F;docpad.coffee:224</code></a>
        </p>


    </div>

    <div class="description">
        <p>Document Model class
Extension of the File Model class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/models/document.coffee">https://github.com/docpad/docpad/blob/master/src/lib/models/document.coffee</a></p>

    </div>



</div>
<div id="property_ElementsCollection" class="property item">
    <h3 class="name"><code>ElementsCollection</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l243"><code>src&#x2F;lib&#x2F;docpad.coffee:243</code></a>
        </p>


    </div>

    <div class="description">
        <p>Collection of elements in a DocPad project
Extension of the Collection class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/collections/elements.coffee">https://github.com/docpad/docpad/blob/master/src/lib/collections/elements.coffee</a></p>

    </div>



</div>
<div id="property_errorRunnerInstance" class="property item">
    <h3 class="name"><code>errorRunnerInstance</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l470"><code>src&#x2F;lib&#x2F;docpad.coffee:470</code></a>
        </p>


    </div>

    <div class="description">
        <p>The error runner instance bound to DocPad</p>

    </div>



</div>
<div id="property_Events" class="property item">
    <h3 class="name"><code>Events</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l180"><code>src&#x2F;lib&#x2F;docpad.coffee:180</code></a>
        </p>


    </div>

    <div class="description">
        <p>Events class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/base.coffee">https://github.com/docpad/docpad/blob/master/src/lib/base.coffee</a></p>

    </div>



</div>
<div id="property_exchange" class="property item">
    <h3 class="name"><code>exchange</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1091"><code>src&#x2F;lib&#x2F;docpad.coffee:1091</code></a>
        </p>


    </div>

    <div class="description">
        <p>A listing of all the available extensions for DocPad</p>

    </div>



</div>
<div id="property_FileModel" class="property item">
    <h3 class="name"><code>FileModel</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l216"><code>src&#x2F;lib&#x2F;docpad.coffee:216</code></a>
        </p>


    </div>

    <div class="description">
        <p>File Model class
Extension of the Model class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/models/file.coffee">https://github.com/docpad/docpad/blob/master/src/lib/models/file.coffee</a></p>

    </div>



</div>
<div id="property_filesByOutPath" class="property item private">
    <h3 class="name"><code>filesByOutPath</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l605"><code>src&#x2F;lib&#x2F;docpad.coffee:605</code></a>
        </p>


    </div>

    <div class="description">
        <p>Files by Out Path. Used to speed up conflict detection. Do not use for anything else</p>

    </div>



</div>
<div id="property_filesBySelector" class="property item private">
    <h3 class="name"><code>filesBySelector</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l598"><code>src&#x2F;lib&#x2F;docpad.coffee:598</code></a>
        </p>


    </div>

    <div class="description">
        <p>Files by Selector. Used to speed up fetching</p>

    </div>



</div>
<div id="property_filesByUrl" class="property item private">
    <h3 class="name"><code>filesByUrl</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l591"><code>src&#x2F;lib&#x2F;docpad.coffee:591</code></a>
        </p>


    </div>

    <div class="description">
        <p>Files by url. Used to speed up fetching</p>

    </div>



</div>
<div id="property_FilesCollection" class="property item">
    <h3 class="name"><code>FilesCollection</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l235"><code>src&#x2F;lib&#x2F;docpad.coffee:235</code></a>
        </p>


    </div>

    <div class="description">
        <p>Collection of files in a DocPad project
Extension of the QueryCollection class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/collections/files.coffee">https://github.com/docpad/docpad/blob/master/src/lib/collections/files.coffee</a></p>

    </div>



</div>
<div id="property_generated" class="property item private">
    <h3 class="name"><code>generated</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4640"><code>src&#x2F;lib&#x2F;docpad.coffee:4640</code></a>
        </p>


    </div>

    <div class="description">
        <p>Has DocPad done at least one generation?
True once the first generation has occured.</p>

    </div>



</div>
<div id="property_generateEnded" class="property item private">
    <h3 class="name"><code>generateEnded</code></h3>
    <span class="type">Boolean</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4626"><code>src&#x2F;lib&#x2F;docpad.coffee:4626</code></a>
        </p>


    </div>

    <div class="description">
        <p>Has DocPad's generation process ended?</p>

    </div>



</div>
<div id="property_generateStarted" class="property item private">
    <h3 class="name"><code>generateStarted</code></h3>
    <span class="type">Boolean</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4619"><code>src&#x2F;lib&#x2F;docpad.coffee:4619</code></a>
        </p>


    </div>

    <div class="description">
        <p>Has DocPad's generation process started?</p>

    </div>



</div>
<div id="property_generating" class="property item private">
    <h3 class="name"><code>generating</code></h3>
    <span class="type">Boolean</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l4633"><code>src&#x2F;lib&#x2F;docpad.coffee:4633</code></a>
        </p>


    </div>

    <div class="description">
        <p>Is DocPad currently generating?</p>

    </div>



</div>
<div id="property_initialConfig" class="property item private">
    <h3 class="name"><code>initialConfig</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1434"><code>src&#x2F;lib&#x2F;docpad.coffee:1434</code></a>
        </p>


    </div>

    <div class="description">
        <p>Initial Configuration. The default docpadConfig
settings that can be overridden in a project's docpad.coffee file.
Merged into the config property</p>

    </div>



</div>
<div id="property_initialTemplateData" class="property item private">
    <h3 class="name"><code>initialTemplateData</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1147"><code>src&#x2F;lib&#x2F;docpad.coffee:1147</code></a>
        </p>


    </div>

    <div class="description">
        <p>Description for initialTemplateData</p>

    </div>



</div>
<div id="property_instanceConfig" class="property item private">
    <h3 class="name"><code>instanceConfig</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1389"><code>src&#x2F;lib&#x2F;docpad.coffee:1389</code></a>
        </p>


    </div>

    <div class="description">
        <p>Instance Configuration</p>

    </div>



</div>
<div id="property_libPath" class="property item private">
    <h3 class="name"><code>libPath</code></h3>
    <span class="type">String</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1106"><code>src&#x2F;lib&#x2F;docpad.coffee:1106</code></a>
        </p>


    </div>

    <div class="description">
        <p>The DocPad library directory</p>

    </div>



</div>
<div id="property_loadedPlugins" class="property item">
    <h3 class="name"><code>loadedPlugins</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1085"><code>src&#x2F;lib&#x2F;docpad.coffee:1085</code></a>
        </p>


    </div>

    <div class="description">
        <p>Loaded plugins indexed by name</p>

    </div>



</div>
<div id="property_locale" class="property item private">
    <h3 class="name"><code>locale</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1278"><code>src&#x2F;lib&#x2F;docpad.coffee:1278</code></a>
        </p>


    </div>

    <div class="description">
        <p>Determined locale</p>

    </div>



</div>
<div id="property_localePath" class="property item">
    <h3 class="name"><code>localePath</code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1125"><code>src&#x2F;lib&#x2F;docpad.coffee:1125</code></a>
        </p>


    </div>

    <div class="description">
        <p>The DocPad locale path</p>

    </div>



</div>
<div id="property_log" class="property item">
    <h3 class="name"><code>log</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l3225"><code>src&#x2F;lib&#x2F;docpad.coffee:3225</code></a>
        </p>


    </div>

    <div class="description">
        <p>Log arguments</p>

    </div>



        <h4>Sub-properties:</h4>

        <ul class="params-list">
            <li class="param">
                    <code class="param-name">args...</code>
                    <span class="type">Mixed</span>

                <div class="param-description">
                     
                </div>

            </li>
        </ul>
</div>
<div id="property_loggerInstances" class="property item private">
    <h3 class="name"><code>loggerInstances</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l400"><code>src&#x2F;lib&#x2F;docpad.coffee:400</code></a>
        </p>


    </div>

    <div class="description">
        <p>Internal property. The caterpillar logger instances bound to DocPad</p>

    </div>



</div>
<div id="property_mainPath" class="property item">
    <h3 class="name"><code>mainPath</code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1113"><code>src&#x2F;lib&#x2F;docpad.coffee:1113</code></a>
        </p>


    </div>

    <div class="description">
        <p>The main DocPad file</p>

    </div>



</div>
<div id="property_MetaCollection" class="property item">
    <h3 class="name"><code>MetaCollection</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l251"><code>src&#x2F;lib&#x2F;docpad.coffee:251</code></a>
        </p>


    </div>

    <div class="description">
        <p>Collection of metadata in a DocPad project
Extension of the ElementsCollection class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/collections/meta.coffee">https://github.com/docpad/docpad/blob/master/src/lib/collections/meta.coffee</a></p>

    </div>



</div>
<div id="property_Model" class="property item">
    <h3 class="name"><code>Model</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l186"><code>src&#x2F;lib&#x2F;docpad.coffee:186</code></a>
        </p>


    </div>

    <div class="description">
        <p>Model class
Extension of the Backbone Model class
<a href="http://backbonejs.org/#Model">http://backbonejs.org/#Model</a>
<a href="https://github.com/docpad/docpad/blob/master/src/lib/base.coffee">https://github.com/docpad/docpad/blob/master/src/lib/base.coffee</a></p>

    </div>



</div>
<div id="property_packagePath" class="property item">
    <h3 class="name"><code>packagePath</code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1119"><code>src&#x2F;lib&#x2F;docpad.coffee:1119</code></a>
        </p>


    </div>

    <div class="description">
        <p>The DocPad package.json path</p>

    </div>



</div>
<div id="property_PluginLoader" class="property item">
    <h3 class="name"><code>PluginLoader</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l275"><code>src&#x2F;lib&#x2F;docpad.coffee:275</code></a>
        </p>


    </div>

    <div class="description">
        <p>Plugin Loader class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/plugin-loader.coffee">https://github.com/docpad/docpad/blob/master/src/lib/plugin-loader.coffee</a>
Loads the DocPad plugins from the file system into
a DocPad project</p>

    </div>



</div>
<div id="property_pluginsTemplateData" class="property item private">
    <h3 class="name"><code>pluginsTemplateData</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1154"><code>src&#x2F;lib&#x2F;docpad.coffee:1154</code></a>
        </p>


    </div>

    <div class="description">
        <p>Plugin's Extended Template Data</p>

    </div>



</div>
<div id="property_pluginVersion" class="property item">
    <h3 class="name"><code>pluginVersion</code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l321"><code>src&#x2F;lib&#x2F;docpad.coffee:321</code></a>
        </p>


    </div>

    <div class="description">
        <p>The plugin version requirements</p>

    </div>



</div>
<div id="property_QueryCollection" class="property item">
    <h3 class="name"><code>QueryCollection</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l204"><code>src&#x2F;lib&#x2F;docpad.coffee:204</code></a>
        </p>


    </div>

    <div class="description">
        <p>QueryCollection class
Extension of the Query Engine QueryCollection class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/base.coffee">https://github.com/docpad/docpad/blob/master/src/lib/base.coffee</a>
<a href="https://github.com/bevry/query-engine/blob/master/src/documents/lib/query-engine.js.coffee">https://github.com/bevry/query-engine/blob/master/src/documents/lib/query-engine.js.coffee</a></p>

    </div>



</div>
<div id="property_regenerateTimer" class="property item private">
    <h3 class="name"><code>regenerateTimer</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1728"><code>src&#x2F;lib&#x2F;docpad.coffee:1728</code></a>
        </p>


    </div>

    <div class="description">
        <p>Regenerate Timer
When config.regenerateEvery is set to a value, we create a timer here</p>

    </div>



</div>
<div id="property_ScriptsCollection" class="property item">
    <h3 class="name"><code>ScriptsCollection</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l259"><code>src&#x2F;lib&#x2F;docpad.coffee:259</code></a>
        </p>


    </div>

    <div class="description">
        <p>Collection of JS script files in a DocPad project
Extension of the ElementsCollection class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/collections/scripts.coffee">https://github.com/docpad/docpad/blob/master/src/lib/collections/scripts.coffee</a></p>

    </div>



</div>
<div id="property_serverExpress" class="property item private">
    <h3 class="name"><code>serverExpress</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l342"><code>src&#x2F;lib&#x2F;docpad.coffee:342</code></a>
        </p>


    </div>

    <div class="description">
        <p>The express.js server instance bound to DocPad.
<a href="http://expressjs.com">http://expressjs.com</a></p>

    </div>



</div>
<div id="property_serverHttp" class="property item private">
    <h3 class="name"><code>serverHttp</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l350"><code>src&#x2F;lib&#x2F;docpad.coffee:350</code></a>
        </p>


    </div>

    <div class="description">
        <p>The Node.js http server instance bound to DocPad
<a href="https://nodejs.org/api/http.html">https://nodejs.org/api/http.html</a></p>

    </div>



</div>
<div id="property_skeletonsCollection" class="property item private">
    <h3 class="name"><code>skeletonsCollection</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1017"><code>src&#x2F;lib&#x2F;docpad.coffee:1017</code></a>
        </p>


    </div>

    <div class="description">
        <p>Skeletons Collection</p>

    </div>



</div>
<div id="property_slowPlugins" class="property item">
    <h3 class="name"><code>slowPlugins</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1079"><code>src&#x2F;lib&#x2F;docpad.coffee:1079</code></a>
        </p>


    </div>

    <div class="description">
        <p>Plugins that are loading really slow</p>

    </div>



</div>
<div id="property_string array of event names" class="property item private">
    <h3 class="name"><code>string array of event names</code></h3>
    <span class="type">Array</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l498"><code>src&#x2F;lib&#x2F;docpad.coffee:498</code></a>
        </p>


    </div>

    <div class="description">
        <p>Event Listing. String array of event names.
Whenever an event is created, it must be applied here to be available to plugins and configuration files
<a href="https://github.com/bevry/docpad/wiki/Events">https://github.com/bevry/docpad/wiki/Events</a></p>

    </div>



</div>
<div id="property_string constant" class="property item private">
    <h3 class="name"><code>string constant</code></h3>
    <span class="type">String</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1359"><code>src&#x2F;lib&#x2F;docpad.coffee:1359</code></a>
        </p>


    </div>

    <div class="description">
        <p>Hash Key
The key that we use to hash some data before sending it to our statistic server</p>

    </div>



</div>
<div id="property_StylesCollection" class="property item">
    <h3 class="name"><code>StylesCollection</code></h3>
    <span class="type">Object</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l267"><code>src&#x2F;lib&#x2F;docpad.coffee:267</code></a>
        </p>


    </div>

    <div class="description">
        <p>Collection of CSS style files in a DocPad project
Extension of the ElementsCollection class
<a href="https://github.com/docpad/docpad/blob/master/src/lib/collections/styles.coffee">https://github.com/docpad/docpad/blob/master/src/lib/collections/styles.coffee</a></p>

    </div>



</div>
<div id="property_trackRunnerInstance" class="property item private">
    <h3 class="name"><code>trackRunnerInstance</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l483"><code>src&#x2F;lib&#x2F;docpad.coffee:483</code></a>
        </p>


    </div>

    <div class="description">
        <p>The track runner instance bound to DocPad</p>

    </div>



</div>
<div id="property_userConfig" class="property item private">
    <h3 class="name"><code>userConfig</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1405"><code>src&#x2F;lib&#x2F;docpad.coffee:1405</code></a>
        </p>


    </div>

    <div class="description">
        <p>User Configuraiton
Merged into the config property</p>

    </div>



</div>
<div id="property_userConfigPath" class="property item">
    <h3 class="name"><code>userConfigPath</code></h3>
    <span class="type">String</span>





    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1137"><code>src&#x2F;lib&#x2F;docpad.coffee:1137</code></a>
        </p>


    </div>

    <div class="description">
        <p>The User's configuration path (.docpad.cson)</p>

    </div>



</div>
<div id="property_version" class="property item private">
    <h3 class="name"><code>version</code></h3>
    <span class="type">Number</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l294"><code>src&#x2F;lib&#x2F;docpad.coffee:294</code></a>
        </p>


    </div>

    <div class="description">
        <p>DocPad's version number</p>

    </div>



</div>
<div id="property_watchers" class="property item private">
    <h3 class="name"><code>watchers</code></h3>
    <span class="type">Array</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l5311"><code>src&#x2F;lib&#x2F;docpad.coffee:5311</code></a>
        </p>


    </div>

    <div class="description">
        <p>Array of file watchers</p>

    </div>



</div>
<div id="property_websiteConfig" class="property item private">
    <h3 class="name"><code>websiteConfig</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1397"><code>src&#x2F;lib&#x2F;docpad.coffee:1397</code></a>
        </p>


    </div>

    <div class="description">
        <p>Website Configuration
Merged into the config property</p>

    </div>



</div>
<div id="property_websitePackageConfig" class="property item private">
    <h3 class="name"><code>websitePackageConfig</code></h3>
    <span class="type">Object</span>


        <span class="flag private">private</span>



    <div class="meta">
                <p>
                Defined in
        <a href="../files/src_lib_docpad.coffee.html#l1367"><code>src&#x2F;lib&#x2F;docpad.coffee:1367</code></a>
        </p>


    </div>

    <div class="description">
        <p>Website Package Configuration</p>

    </div>



</div>
            </div>


    </div>
</div>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
